Ulm Ux Api

Uses Cases

This usecase is used to fetch the Customer and Account Details based on service Id(Phone Number)

URL

https://nonprod.esb.lla.com/dev/ulm-ux/ulm-ux/v1/v1/{businessId}/service/{serviceId}/relatedEntity?referredType=BillingAccount&expand=service.relatedEntity,service.relatedEntity.relatedParty

###

cURL Request

curl --location 'https://nonprod.esb.lla.com/dev/ulm-ux/ulm-ux/v1/PR/service/7874810241/relatedEntity?referredType=BillingAccount&expand=service.relatedEntity,service.relatedEntity.relatedParty' \
--header 'client_id: xxxxxxx' \
--header 'client_secret: xxxxxxx' \
--header 'X-Correlation-ID: 2-23d2c8d0-2fb4-11ef-94fc-005056a2a8c5'

URL PARAMS

Header

Query Param

Body

NOTE:

1. All Use Cases are listed and referenced to their examples on Use Case section
2. All definitions are described on RAML, inside of Anypoint Design Center.

Definitions

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - request processed successfully, response body contains an entity corresponding to the requested resource.

NOTE:

1. All Use Cases are listed and referenced to their examples on Use Case section
2. All definitions are described on RAML, inside of Anypoint Design Center.

Response (case for company businessAccount)

In this section all the possible data structures received by the client at the moment of responding the method are defined.

[{

  "id": "8211990010005122",
  "name": "LIZ FUENTES",
  "accountType": "RES",
  "state": "InActive",
  "startDate": "2020-10-26T00:00:00.000-04:00",
  "contact": [
    {
      "contactName": "LIZ FUENTES",
      "contactType": "primary",
      "partyRoleType": "customer",
      "contactMedium": [
        {
          "mediumType": "PostalAddress",
          "characteristic": {
            "city": "SAN JUAN",
            "street1": "279 AVE PONCE DE LEON<",
            "postCode": "009171920",
            "stateOrProvince": "PR",
            "country": "USA"
          }
        },
        {
          "mediumType": "Phone",
          "characteristic": {
            "contactType": "Primary",
            "phoneNumber": "7874810241"
          }
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "@referredType": "Organization",
      "href": "[https://nonprod.esb.cloud.lla.com/dev/tmf-api/partyManagement/v4/organization/1101519838002](https://nonprod.esb.cloud.lla.com/dev/tmf-api/partyManagement/v4/organization/1101519838002)",
      "id": "1101519838002",
      "name": "LIZ FUENTES",
      "role": "customer",
      "organizationIdentification": [
        {
          "identificationType": "TaxIdentifier",
          "identificationId": "XXXXXXXXX"
        }
      ]
    }
  ],
  "@type": "BillingAccount"
}]

Response (case for personal business account)

[{

  "id": "8211990010005122",
  "name": "LIZ FUENTES",
  "accountType": "RES",
  "state": "InActive",
  "startDate": "2020-10-26T00:00:00.000-04:00",
  "contact": [
    {
      "contactName": "LIZ FUENTES",
      "contactType": "primary",
      "partyRoleType": "customer",
      "contactMedium": [
        {
          "mediumType": "PostalAddress",
          "characteristic": {
            "city": "SAN JUAN",
            "street1": "279 AVE PONCE DE LEON<",
            "postCode": "009171920",
            "stateOrProvince": "PR",
            "country": "USA"
          }
        },
        {
          "mediumType": "Phone",
          "characteristic": {
            "contactType": "Primary",
            "phoneNumber": "7874810241"
          }
        }
      ]
    }
  ],
  "relatedParty": [
    {
      "@referredType": "Individual",
      "href": "[https://host:port/tmf-api/partyManagement/v4/individual/1101519838002](https://host:port/tmf-api/partyManagement/v4/individual/1101519838002)",
      "id": "1101519838002",
      "name": "LIZ FUENTES",
      "role": "customer",
      "individualIdentification": [
        {
          "identificationType": "TaxIdentifier",
          "identificationId": "XXXXXXXXX"
        }
      ]
    }
  ],
  "@type": "BillingAccount"
}]

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource."
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
    "message": "Resource not found"
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description": "The request failed due to an internal error."
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /service for Business Id: xxxx not implemented"
    }]
  }

Response

Definitions

Each of the request parameters is detailed.